<!DOCTYPE html>
<html lang="en">
<head>
<title>Brook Tardigrade: BrookMathExpression: Class TBrookMathExpression</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="generator" content="PasDoc 0.16.0">
<meta http-equiv="content-type" content="text/html; charset=utf-8">
<link rel="stylesheet" type="text/css" href="tipuesearch/tipuesearch.css">

<link rel="StyleSheet" type="text/css" href="pasdoc.css">
</head>
<body>
<div class="container"><div class="navigation">
<h2><a href="index.html">Brook Tardigrade</a></h2><ul><li><a href="AllUnits.html">Units</a></li><li><a href="ClassHierarchy.html">Class Hierarchy</a></li><li><a href="AllClasses.html">Classes, Interfaces, Objects and Records</a></li><li><a href="AllTypes.html">Types</a></li><li><a href="AllVariables.html">Variables</a></li><li><a href="AllConstants.html">Constants</a></li><li><a href="AllFunctions.html">Functions and Procedures</a></li><li><a href="AllIdentifiers.html">Identifiers</a></li><li><form class="search-form" action="tipue_results.html"><div class="search-input"><input type="text" name="q" id="tipue_search_input" pattern=".{3,}" title="At least 3 characters" required><div class="search-button"><input type="button" id="tipue_search_button" onclick="this.form.submit();"></div></div></form>
<div style="clear: both"></div>
</li></ul></div><div class="content">
<span id="TBrookMathExpression"></span><h1 class="cio">Class TBrookMathExpression</h1>
<div class="sections">
<div class="one_section"><a class="section" href="#PasDoc-Description">Description</a></div><div class="one_section"><a class="section" href="#PasDoc-Hierarchy">Hierarchy</a></div><div class="one_section">Fields</div><div class="one_section"><a class="section" href="#PasDoc-Methods">Methods</a></div><div class="one_section"><a class="section" href="#PasDoc-Properties">Properties</a></div></div>
<span id="PasDoc-Description"></span><h2 class="unit">Unit</h2>
<p class="unitlink">
<a href="BrookMathExpression.html">BrookMathExpression</a></p>
<h2 class="declaration">Declaration</h2>
<p class="declaration">
<code>type TBrookMathExpression = class(<a class="normal" href="BrookHandledClasses.TBrookHandledComponent.html">TBrookHandledComponent</a>)</code></p>
<h2 class="description">Description</h2>
<p>
Mathematical <a class="normal" href="BrookMathExpression.TBrookMathExpression.html#Expression">expression</a> evaluator.</p>
<span id="PasDoc-Hierarchy"></span><h2 class="hierarchy">Hierarchy</h2>
<ul class="hierarchy"><li class="ancestor">TObject</li>
<li class="ancestor">TPersistent</li>
<li class="ancestor">TComponent</li>
<li class="ancestor"><a class="normal" href="BrookHandledClasses.TBrookHandledComponent.html">TBrookHandledComponent</a></li>
<li class="thisitem">TBrookMathExpression</li></ul><h2 class="overview">Overview</h2>
<span id="PasDoc-Methods"></span><h3 class="summary">Methods</h3>
<table class="summary wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>constructor <strong><a href="BrookMathExpression.TBrookMathExpression.html#Create">Create</a></strong>(AOwner: TComponent); override;</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>destructor <strong><a href="BrookMathExpression.TBrookMathExpression.html#Destroy">Destroy</a></strong>; override;</code></td>
</tr>
<tr class="list">
<td class="visibility"><a href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>procedure <strong><a href="BrookMathExpression.TBrookMathExpression.html#Open">Open</a></strong>;</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>procedure <strong><a href="BrookMathExpression.TBrookMathExpression.html#Close">Close</a></strong>;</code></td>
</tr>
<tr class="list">
<td class="visibility"><a href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>function <strong><a href="BrookMathExpression.TBrookMathExpression.html#Compile">Compile</a></strong>(const AExpression: string; out AError: <a href="BrookMathExpression.TBrookMathExpressionError.html">TBrookMathExpressionError</a>): Boolean; overload; virtual;</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>function <strong><a href="BrookMathExpression.TBrookMathExpression.html#Compile">Compile</a></strong>(const AExpression: string): Boolean; overload; virtual;</code></td>
</tr>
<tr class="list">
<td class="visibility"><a href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>procedure <strong><a href="BrookMathExpression.TBrookMathExpression.html#Clear">Clear</a></strong>; virtual;</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>function <strong><a href="BrookMathExpression.TBrookMathExpression.html#Evaluate">Evaluate</a></strong>: Double; virtual;</code></td>
</tr>
<tr class="list">
<td class="visibility"><a href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>function <strong><a href="BrookMathExpression.TBrookMathExpression.html#GetVariable">GetVariable</a></strong>(const AName: string): Double; virtual;</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>procedure <strong><a href="BrookMathExpression.TBrookMathExpression.html#SetVariable">SetVariable</a></strong>(const AName: string; const AValue: Double); virtual;</code></td>
</tr>
</table>
<span id="PasDoc-Properties"></span><h3 class="summary">Properties</h3>
<table class="summary wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>property <strong><a href="BrookMathExpression.TBrookMathExpression.html#Compiled">Compiled</a></strong>: Boolean read FCompiled;</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>property <strong><a href="BrookMathExpression.TBrookMathExpression.html#Variables">Variables</a></strong>[constAName:string]: Double read <a href="BrookMathExpression.TBrookMathExpression.html#GetVariable">GetVariable</a>
      write <a href="BrookMathExpression.TBrookMathExpression.html#SetVariable">SetVariable</a>;</code></td>
</tr>
<tr class="list">
<td class="visibility"><a href="legend.html"><img  src="published.gif" alt="Published" title="Published"></a></td>
<td class="itemcode"><code>property <strong><a href="BrookMathExpression.TBrookMathExpression.html#Active">Active</a></strong>: Boolean read FActive write SetActive stored IsActiveStored;</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a href="legend.html"><img  src="published.gif" alt="Published" title="Published"></a></td>
<td class="itemcode"><code>property <strong><a href="BrookMathExpression.TBrookMathExpression.html#Expression">Expression</a></strong>: string read FExpression write SetExpression;</code></td>
</tr>
<tr class="list">
<td class="visibility"><a href="legend.html"><img  src="published.gif" alt="Published" title="Published"></a></td>
<td class="itemcode"><code>property <strong><a href="BrookMathExpression.TBrookMathExpression.html#Extensions">Extensions</a></strong>: TStringList read FExtensions write SetExtensions;</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a href="legend.html"><img  src="published.gif" alt="Published" title="Published"></a></td>
<td class="itemcode"><code>property <strong><a href="BrookMathExpression.TBrookMathExpression.html#OnExtension">OnExtension</a></strong>: <a href="BrookMathExpression.html#TBrookMathExpressionExtensionEvent">TBrookMathExpressionExtensionEvent</a> read FOnExtension
      write FOnExtension;</code></td>
</tr>
<tr class="list">
<td class="visibility"><a href="legend.html"><img  src="published.gif" alt="Published" title="Published"></a></td>
<td class="itemcode"><code>property <strong><a href="BrookMathExpression.TBrookMathExpression.html#OnError">OnError</a></strong>: <a href="BrookMathExpression.html#TBrookMathExpressionErrorEvent">TBrookMathExpressionErrorEvent</a> read FOnError
      write FOnError;</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a href="legend.html"><img  src="published.gif" alt="Published" title="Published"></a></td>
<td class="itemcode"><code>property <strong><a href="BrookMathExpression.TBrookMathExpression.html#OnActivate">OnActivate</a></strong>: TNotifyEvent read FOnActivate write FOnActivate;</code></td>
</tr>
<tr class="list">
<td class="visibility"><a href="legend.html"><img  src="published.gif" alt="Published" title="Published"></a></td>
<td class="itemcode"><code>property <strong><a href="BrookMathExpression.TBrookMathExpression.html#OnDeactivate">OnDeactivate</a></strong>: TNotifyEvent read FOnDeactivate write FOnDeactivate;</code></td>
</tr>
</table>
<h2 class="description">Description</h2>
<h3 class="detail">Methods</h3>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><span id="Create"></span><code>constructor <strong>Create</strong>(AOwner: TComponent); override;</code></td>
</tr>
<tr><td colspan="2">
<p>
Creates an instance of <code><a class="normal" href="BrookMathExpression.TBrookMathExpression.html">TBrookMathExpression</a></code>. </p>
<h6 class="description_section">Parameters</h6>
<dl class="parameters">
<dt>AOwner[in]</dt>
<dd>Owner component.</dd>
</dl>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><span id="Destroy"></span><code>destructor <strong>Destroy</strong>; override;</code></td>
</tr>
<tr><td colspan="2">
<p>
Destroys an instance of <code><a class="normal" href="BrookMathExpression.TBrookMathExpression.html">TBrookMathExpression</a></code>.</p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><span id="Open"></span><code>procedure <strong>Open</strong>;</code></td>
</tr>
<tr><td colspan="2">
<p>
Opens the math <a class="normal" href="BrookMathExpression.TBrookMathExpression.html#Expression">expression</a>.</p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><span id="Close"></span><code>procedure <strong>Close</strong>;</code></td>
</tr>
<tr><td colspan="2">
<p>
Closes the math <a class="normal" href="BrookMathExpression.TBrookMathExpression.html#Expression">expression</a>.</p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><span id="Compile"></span><code>function <strong>Compile</strong>(const AExpression: string; out AError: <a href="BrookMathExpression.TBrookMathExpressionError.html">TBrookMathExpressionError</a>): Boolean; overload; virtual;</code></td>
</tr>
<tr><td colspan="2">
<p>
Compiles a mathematical <a class="normal" href="BrookMathExpression.TBrookMathExpression.html#Expression">expression</a> returning the errors if it does not succeed.   </p>
<h6 class="description_section">Parameters</h6>
<dl class="parameters">
<dt>AExpression[in]</dt>
<dd>Mathematical <a class="normal" href="BrookMathExpression.TBrookMathExpression.html#Expression">expression</a>.</dd>
<dt>AError[out]</dt>
<dd>Mathematical <a class="normal" href="BrookMathExpression.TBrookMathExpression.html#Expression">expression</a> error.</dd>
</dl>
<h6 class="description_section">Returns</h6>
<p class="return"><code>True</code> if compilation succeeds.</p></td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><span id="Compile"></span><code>function <strong>Compile</strong>(const AExpression: string): Boolean; overload; virtual;</code></td>
</tr>
<tr><td colspan="2">
<p>
Compiles a mathematical <a class="normal" href="BrookMathExpression.TBrookMathExpression.html#Expression">expression</a> indicating if it succeeds.  </p>
<h6 class="description_section">Parameters</h6>
<dl class="parameters">
<dt>AExpression[in]</dt>
<dd>Mathematical <a class="normal" href="BrookMathExpression.TBrookMathExpression.html#Expression">expression</a>.</dd>
</dl>
<h6 class="description_section">Returns</h6>
<p class="return"><code>True</code> if compilation succeeds.</p></td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><span id="Clear"></span><code>procedure <strong>Clear</strong>; virtual;</code></td>
</tr>
<tr><td colspan="2">
<p>
Clears a mathematical <a class="normal" href="BrookMathExpression.TBrookMathExpression.html#Expression">expression</a> instance.</p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><span id="Evaluate"></span><code>function <strong>Evaluate</strong>: Double; virtual;</code></td>
</tr>
<tr><td colspan="2">
<p>
Evaluates a <a class="normal" href="BrookMathExpression.TBrookMathExpression.html#Compiled">compiled</a> mathematical <a class="normal" href="BrookMathExpression.TBrookMathExpression.html#Expression">expression</a>. </p>
<h6 class="description_section">Returns</h6>
<p class="return">Evaluated mathematical <a class="normal" href="BrookMathExpression.TBrookMathExpression.html#Expression">expression</a></p></td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><span id="GetVariable"></span><code>function <strong>GetVariable</strong>(const AName: string): Double; virtual;</code></td>
</tr>
<tr><td colspan="2">
<p>
Gets the value of a declared variable.  </p>
<h6 class="description_section">Parameters</h6>
<dl class="parameters">
<dt>AName[in]</dt>
<dd>Name of the declared variable.</dd>
</dl>
<h6 class="description_section">Returns</h6>
<p class="return">Value of a declared variable.</p></td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><span id="SetVariable"></span><code>procedure <strong>SetVariable</strong>(const AName: string; const AValue: Double); virtual;</code></td>
</tr>
<tr><td colspan="2">
<p>
Sets a variable to the mathematical <a class="normal" href="BrookMathExpression.TBrookMathExpression.html#Expression">expression</a>.  </p>
<h6 class="description_section">Parameters</h6>
<dl class="parameters">
<dt>AName[in]</dt>
<dd>Name for the variable.</dd>
<dt>AValue[in]</dt>
<dd>Value for the variable.</dd>
</dl>
</td></tr>
</table>
<h3 class="detail">Properties</h3>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><span id="Compiled"></span><code>property <strong>Compiled</strong>: Boolean read FCompiled;</code></td>
</tr>
<tr><td colspan="2">
<p>
Indicates if a mathematical <a class="normal" href="BrookMathExpression.TBrookMathExpression.html#Expression">expression</a> has been successfully <code>compiled</code>.</p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><span id="Variables"></span><code>property <strong>Variables</strong>[constAName:string]: Double read <a href="BrookMathExpression.TBrookMathExpression.html#GetVariable">GetVariable</a>
      write <a href="BrookMathExpression.TBrookMathExpression.html#SetVariable">SetVariable</a>;</code></td>
</tr>
<tr><td colspan="2">
<p>
Gets or sets a mathematical <a class="normal" href="BrookMathExpression.TBrookMathExpression.html#Expression">expression</a> variable.</p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img  src="published.gif" alt="Published" title="Published"></a></td>
<td class="itemcode"><span id="Active"></span><code>property <strong>Active</strong>: Boolean read FActive write SetActive stored IsActiveStored;</code></td>
</tr>
<tr><td colspan="2">
<p>
Activates the mathematical <a class="normal" href="BrookMathExpression.TBrookMathExpression.html#Expression">expression</a> evaluator.</p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img  src="published.gif" alt="Published" title="Published"></a></td>
<td class="itemcode"><span id="Expression"></span><code>property <strong>Expression</strong>: string read FExpression write SetExpression;</code></td>
</tr>
<tr><td colspan="2">
<p>
Declares the mathematical <code>expression</code>.</p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img  src="published.gif" alt="Published" title="Published"></a></td>
<td class="itemcode"><span id="Extensions"></span><code>property <strong>Extensions</strong>: TStringList read FExtensions write SetExtensions;</code></td>
</tr>
<tr><td colspan="2">
<p>
Declares the list of mathematical <a class="normal" href="BrookMathExpression.TBrookMathExpression.html#Expression">expression</a> <code>extensions</code>.</p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img  src="published.gif" alt="Published" title="Published"></a></td>
<td class="itemcode"><span id="OnExtension"></span><code>property <strong>OnExtension</strong>: <a href="BrookMathExpression.html#TBrookMathExpressionExtensionEvent">TBrookMathExpressionExtensionEvent</a> read FOnExtension
      write FOnExtension;</code></td>
</tr>
<tr><td colspan="2">
<p>
Event triggered when an <a class="normal" href="BrookMathExpression.TBrookMathExpression.html#Extensions">extensions</a> is called in the mathematical <a class="normal" href="BrookMathExpression.TBrookMathExpression.html#Expression">expression</a>.</p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img  src="published.gif" alt="Published" title="Published"></a></td>
<td class="itemcode"><span id="OnError"></span><code>property <strong>OnError</strong>: <a href="BrookMathExpression.html#TBrookMathExpressionErrorEvent">TBrookMathExpressionErrorEvent</a> read FOnError
      write FOnError;</code></td>
</tr>
<tr><td colspan="2">
<p>
Event triggered when a mathematical <a class="normal" href="BrookMathExpression.TBrookMathExpression.html#Expression">expression</a> compilation fails.</p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img  src="published.gif" alt="Published" title="Published"></a></td>
<td class="itemcode"><span id="OnActivate"></span><code>property <strong>OnActivate</strong>: TNotifyEvent read FOnActivate write FOnActivate;</code></td>
</tr>
<tr><td colspan="2">
<p>
Event triggered when the math <a class="normal" href="BrookMathExpression.TBrookMathExpression.html#Expression">expression</a> component is enabled.</p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img  src="published.gif" alt="Published" title="Published"></a></td>
<td class="itemcode"><span id="OnDeactivate"></span><code>property <strong>OnDeactivate</strong>: TNotifyEvent read FOnDeactivate write FOnDeactivate;</code></td>
</tr>
<tr><td colspan="2">
<p>
Event triggered when the math <a class="normal" href="BrookMathExpression.TBrookMathExpression.html#Expression">expression</a> component is disabled.</p>
</td></tr>
</table>
<hr><span class="appinfo"><em>Generated by <a href="https://pasdoc.github.io/">PasDoc 0.16.0</a>. </em>
</span>
</div></div></body></html>
